PUT api/data/{authenticationToken}/{loanKey}

This method is used to write data to a loan.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
authenticationToken

Current authentication token

string

Required

loanKey

The loan key string identifying the loan whose data will be updated

string

Required

Body Parameters

This is an object with a single property named Data. This Data property is a dictionary of data paths with the corresponding values that will be updated on the loan.

DataModel
NameDescriptionTypeAdditional information
Data

This is a dictionary of data paths with their corresponding values.

Dictionary of string [key] and Object [value]

None.

Request Formats

application/json, text/json

Sample:
{
  "Data": {
    "sample string 1": {},
    "sample string 3": {}
  }
}

application/xml, text/xml

Sample:
<DataModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/EpicAPI.Models">
  <Data xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringanyType>
      <d2p1:Key>sample string 1</d2p1:Key>
      <d2p1:Value />
    </d2p1:KeyValueOfstringanyType>
    <d2p1:KeyValueOfstringanyType>
      <d2p1:Key>sample string 3</d2p1:Key>
      <d2p1:Value />
    </d2p1:KeyValueOfstringanyType>
  </Data>
</DataModel>

application/x-www-form-urlencoded

Sample:
Data=value

Response Information

Resource Description

If the data was successfully written, "Success" will be returned. Otherwise an error message will be returned.

HttpResponseMessage
NameDescriptionTypeAdditional information
Version

Version

None.

Content

HttpContent

None.

StatusCode

HttpStatusCode

None.

ReasonPhrase

string

None.

Headers

Collection of Object

None.

RequestMessage

HttpRequestMessage

None.

IsSuccessStatusCode

boolean

None.